home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / overm82.zip / OVERMAIL.DOC < prev    next >
Text File  |  1990-02-21  |  18KB  |  395 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                  OverMail v0.82
  11.                          Netmail Utilities for RBBS-PC
  12.                                     02-10-90
  13.  
  14.                                  by Tom Collins
  15.                         Documentation by Michael Huggins
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                                 Latest Versions 
  29.                                 --------------- 
  30.  
  31.         The latest version of all of the OverMail programs is available on 
  32.     the Fisherman's Cove BBS, 1-301-343-1102, under the name OVERMAIL.ZIP.
  33.     If you'd like to file request them, the magic name OVERMAIL will always 
  34.     get you the latest version. 
  35.  
  36.         As of this release, the latest software versions are: 
  37.     
  38.            F2RC.EXE ........ v0.82 
  39.            R2FC.EXE ........ v0.82 
  40.            RENUM311.EXE .... v3.11 
  41.            PIP.EXE ......... v1.20 
  42.      
  43.      
  44.                                  What they Are 
  45.                                  -------------
  46.  
  47.         The OverMail series of programs are utilities that, along with a 
  48.     few other programs, allow you to link your RBBS-PC bulletin board into 
  49.     the FidoNet or other compatible mail networks.  OverMail works with 
  50.     RBBS-PC v17.2A or higher versions.  Four programs are supplied which 
  51.     manipulate your RBBS-PC message bases and convert messages to and from 
  52.     the FidoNet message format.  One utility converts from RBBS to FidoNet 
  53.     format and one converts from FidoNet to RBBS.  In addition, message 
  54.     base packing and renumbering utilities are also supplied which will 
  55.     work on local message bases as well as FidoNet message bases. 
  56.    
  57.         Here's how the system works: your RBBS-PC system is set up with a 
  58.     front-end "mailer," which communicates with other FidoNet systems.  
  59.     Mail is passed back and forth between systems in the form of "packets," 
  60.     which may be archived.  When a packet is received on your system, it is 
  61.     placed by the mailer in a special disk directory, called your "inbound" 
  62.     directory.  Special mail programs, like CONFMAIL and QMail, process 
  63.     these packets and convert them into a series of "message files" on your 
  64.     disk, with filenames like "2.MSG."  The OverMail importing program, 
  65.     F2RC (Fido-to-RBBS-Converter) processes these "*.MSG" files and imports 
  66.     them into your RBBS "xxxM.DEF" conference message files.  Here, your 
  67.     users can read and reply to these messages. 
  68.     
  69.         If a user on your system enters a new message in one of the RBBS 
  70.     message bases, the OverMail program R2FC (RBBS-to-Fido-Converter) 
  71.     senses this, and exports the message into the *.MSG format, where it'll 
  72.     be packetized and sent to other systems by your mailer.  A renumbering 
  73.     program, RENUM311, is supplied to keep your message bases numbered 
  74.     properly.  In addition, a message base packing program, PIP (Pack-in-
  75.     Place) is included in the package for your local message bases to 
  76.     eliminate deleted messages. 
  77.  
  78.                                     History 
  79.                                     ------- 
  80.  
  81.         The first versions of OverMail began development several years ago 
  82.     on a BBS called the OverBoard, run by Tom Collins.  Though the 
  83.     OverBoard is history, the OverMail programs have lived on, and become 
  84.     successively more refined and speedy.  Through the years, several 
  85.     Maryland RBBS-PC sysops have run the programs multiple times daily and 
  86.     found bugs, made suggestions, and the like.  Without these sysops' 
  87.     help, OverMail would not be around today. 
  88.     
  89.                                     Features 
  90.                                     -------- 
  91.  
  92.     o  Speed 
  93.     
  94.     Importing and exporting speeds are limited by the disk drive of the 
  95.     host computer.  On a 12 MHz AT, messages can be imported at about 
  96.     75/min or exported at about 100/min.  When no new messages need to be 
  97.     imported or exported, OverMail can scan approx 50 message bases per 
  98.     minute. 
  99.     
  100.     o  Ease of Use 
  101.     
  102.     All four of the OverMail programs are configured by a single 
  103.     configuration file, which can be created with any text editor. 
  104.     
  105.     o  No Message Corruption 
  106.     
  107.     The original FidoNet *.MSG files can be recreated at will, exactly as 
  108.     they first appeared on disk.  This is useful for systems that serve as 
  109.     links between multiple other systems. 
  110.     
  111.     o  Quality of Import and Export 
  112.     
  113.     Imported messages are copied to the RBBS message base with a minimum of 
  114.     "trash" retained.  Multiple "Re:"s in message subjects, trailing spaces 
  115.     on lines, and occurances of "Joe Blow @ 278/987.0" are removed during 
  116.     import.  In addition, line wrapping is handled as smoothly as possible 
  117.     in all cases. 
  118.     
  119.     o  Netmail Capability 
  120.     
  121.     OverMail can process direct network mail as well as echomail.  Messages 
  122.     can be sent to single system with various message flags set.  File 
  123.     requests and attaches are possible with OverMail. 
  124.      
  125.     o  Message Base Resizing 
  126.     
  127.     OverMail will automatically adjust the size of your RBBS message bases 
  128.     to accomodate any incoming mail.  In addition, it will automatically 
  129.     delete old messages based on number. 
  130.     
  131.     o  Mail Waiting Bit 
  132.     
  133.     OverMail automatically sets RBBS' mail waiting bit for users in 
  134.     conferences. 
  135.      
  136.                                  Getting Set Up 
  137.                                  --------------
  138.  
  139.         To set up OverMail, you'll need a working front-end mailer on your 
  140.     system.  Some of the common front-end mailers are BinkleyTerm, 
  141.     FrontDoor, and D'Bridge.  Your system should be able to exchange mail 
  142.     with other FidoNet systems, and be able to convert received packets 
  143.     into FidoNet *.MSG files and vice-versa.  An excellent program for this 
  144.     task is QMail.  Other programs which accomplish the same functionality 
  145.     of QMail are CONFMAIL and oMMM.  Refer to the documentation for these 
  146.     programs for information on how to set them up. 
  147.  
  148.         Once the mailer and processing software is set up, you should have 
  149.     separate disk directories for each of the FidoNet conferences that you 
  150.     plan to carry, as well as an inbound and outbound directory.  The 
  151.     separate disk directories are where QMail (or CONFMAIL) will send the 
  152.     *.MSGs for that conference.  Also, you should have RBBS conference 
  153.     messages and users files for each of the FidoNet conferences. 
  154.  
  155.         Next, you need to set up the OverMail configuration file. The 
  156.     configuration file is used by all four of the OverMail programs.  You 
  157.     can name the configuration file whatever you want.  We'll use the name 
  158.     OverMail.CFG.  In OverMail.CFG you will need to put the following: 
  159.     
  160.     Line 1:  Your name.
  161.     Line 2:  Your secret RBBS passwords.
  162.     Line 3:  Your network node address, as Net/Node.
  163.     Line 4:  Your default system origin line. See "origin lines," below.
  164.     Line 5+: One line per mail area that you carry.  These lines must
  165.              contain exactly 5 commas.  The lines should be in the
  166.              following format:
  167.  
  168.     Area Name,Messages File,Users File,Max #,Fido Path,Options
  169.  
  170.     where,
  171.  
  172.        Area Name = Name of the Area on your system.
  173.  
  174.        Messages File = Name of the RBBS-PC xxxM.DEF messages file.
  175.  
  176.        Users File = Name of the RBBS-PC xxxU.DEF users file.
  177.  
  178.        Max # = Number of messages to retain in that area.
  179.  
  180.        Fido Path = Full path to where the *.MSG files for that conference
  181.                    are sent when unpacked.
  182.  
  183.        Options = Some combination of the following letters:
  184.                      
  185.           M     Matrix or Netmail area.  This forces F2RC to show the system 
  186.                 that originated the message in the message body, and tells 
  187.                 R2FC to export the messages differently. These are not echo 
  188.                 mail messages and must be treated differently.  If you use 
  189.                 this option and are letting users use a netmail area then 
  190.                 you must explian to them how to write the message.  The 
  191.                 first line of the message must have the destination 
  192.                 net/node number in it.  (see below for details) 
  193.  
  194.           D     Delete private messages rather than export them.  This is 
  195.                 handy if users are writing messages to the sysop in public 
  196.                 echo's. 
  197.  
  198.           P     Publicize private messages. (default)  All messages are made 
  199.                 public before exporting them. 
  200.  
  201.           K     Keep private messages private.  You probably want to use 
  202.                 this option on your matrix mail area. 
  203.  
  204.           A     Allow deleted messages to stay deleted.  By default, if F2RC 
  205.                 finds a message that's been imported and is deleted, it 
  206.                 will un-delete it.  The A option allows it to stay deleted. 
  207.  
  208.           F     FrontDoor mode.  Normally, after F2RC imports a *.MSG it 
  209.                 deletes the *.MSG from disk.  If you're using the FrontDoor 
  210.                 mailer program, this isn't desirable in your netmail area, 
  211.                 as packets get sent using File Attach messages.  If the 
  212.                 *.MSG gets deleted, FrontDoor won't have anything to send. 
  213.                 This option forces F2RC to keep the *.MSGs on disk.
  214.  
  215.                 In this mode F2RC and R2FC divide messages into two 
  216.                 categories: 
  217.  
  218.                 1.  Messages only used for file attaches.  These messages 
  219.                 are identified by the KILL and FILE attributes being set on 
  220.                 the message, as well as a message origin of your system. 
  221.  
  222.                 2.  Normal matrix (netmail) message.  Anything not in 
  223.                 category 1. 
  224.  
  225.                 Messages in category 1 are ignored, while those in category 
  226.                 2 are imported.  The Max # parameter that you specify in 
  227.                 the OverMail configuration file for this area applies to 
  228.                 category 1 messages only. Messages in the second category 
  229.                 are transient, and will be automatically killed by your 
  230.                 mail handler after the message is sent. 
  231.  
  232.                 Two side effects occur due to this setup: 
  233.  
  234.                 1.  F2RC has to scan all of the *.MSGs in an area for every 
  235.                 run.  This causes it to slow down to about 1 second/10 
  236.                 messages on an XT. 
  237.  
  238.                 2.  RENUM311 will often leave "holes" in the message numbers 
  239.                 for this area.  An area with no category 1 messages won't 
  240.                 have any holes. 
  241.  
  242.                 If you're using FrontDoor mode, the following two things 
  243.                 will screw up last-message-read indicators, and should be 
  244.                 avoided: 
  245.  
  246.                 a)  Using a separate renumbering utility on the *.MSGs 
  247.  
  248.                 b)  Deleting the last category 2 message by hand. 
  249.  
  250.           Typically, no options are used for echomail areas, and "MK" is 
  251.           used as matrix mail options. 
  252.  
  253.         Within the configuration file you cannot have any blank lines. You 
  254.     can use a semicolon (;) to designate a comment line, but it must be the 
  255.     first character on the line. 
  256.  
  257.         An example OverMail.CFG is supplied in this archive. 
  258.  
  259.         Once OverMail.CFG is set up, you need to set up your mailer to run 
  260.     the OverMail programs.  Sample batch files and configurations are 
  261.     supplied for FrontDoor and BinkleyTerm.  See FDBATS.ZIP and BTBATS.ZIP, 
  262.     in this archive. 
  263.     
  264.                                   Origin Lines 
  265.                                   ------------
  266.  
  267.         OverMail, by default, uses the origin line in OverMail.CFG.  If 
  268.     you'd like to have a different one for each conference on your system, 
  269.     create a file called ORIGIN in each *.MSG Path.  In this file, put the 
  270.     origin line that you want for that conference.  R2FC will read this 
  271.     file as it exports each message from your system. 
  272.  
  273.                                    Rescanning
  274.                                    ----------
  275.     
  276.         Occasionally, you may need to get the FidoNet *.MSGs back on disk.  
  277.     This could happen, for example, if you start sending an echo conference 
  278.     to a new node and would like to send him all of the old messages in 
  279.     that conference.  OverMail provides a way to do this, called 
  280.     rescanning.  To rescan all of the message areas, add the parameter 
  281.     "/Rescan" to the R2FC command line.  An example is: 
  282.     
  283.                            R2FC OverMail.CFG /Rescan 
  284.  
  285.          
  286.                              Single Area Processing 
  287.                              ----------------------
  288.  
  289.         Any of the OverMail programs can be forced to only process a single 
  290.     message area.  To do this, add "/A" (without the quotes) to the command 
  291.     line, immediately followed by the area NAME.  Here's an example to get 
  292.     R2FC to rescan only a single area:
  293.     
  294.                         R2FC OverMail.CFG /Rescan /ATREK 
  295.  
  296.     To renumber the main messages area only, you might execute:
  297.     
  298.                           RENUM311 OverMail.CFG /AMain 
  299.  
  300.     
  301.                                 Matrix Messaging 
  302.                                 ----------------
  303.  
  304.         If you are planning to use a matrix area here are some helpful 
  305.     hints.  It's a good idea to make your matrix area a sub-board and only 
  306.     allow messages there.  (Read your RBBS-PC manual for details on setting 
  307.     up a sub-board)  Have the main menu for this area only include the 
  308.     commands necessary for messaging.  To send a matrix message, enter the 
  309.     following on the FIRST line of the message: 
  310.  
  311.       destination net/node <options> 
  312.     
  313.             <options>
  314.                       PVT or PRIVATE
  315.                       CRASH
  316.                       KILL
  317.                       RECEIPT
  318.                       ATTACH: (path\filename)
  319.                       REQUEST: (filename)
  320.  
  321.                       PVT = receiver only gets the mail.  It's not a
  322.                       public message.
  323.  
  324.                       CRASH = Send message as soon as possible.
  325.  
  326.                       KILL = Kill (delete) the message when sent.
  327.  
  328.                       RECEIPT = Acknowledgement of delivery.
  329.  
  330.                       ATTACH: (path\filename) = File attach.  Means you
  331.                       wish to send a file with the letter.  Include the
  332.                       complete path and file name of the file you wish
  333.                       to attach.
  334.  
  335.                       REQUEST: = The file you want to receive from the
  336.                       net/node you are sending the letter to.
  337.  
  338.       Example:
  339.  
  340.       +--- column 1 (first character on the line)
  341.       v
  342.       261/1041 Crash Pvt Attach: c:\rbbs\files\echolist.zip
  343.  
  344.       The file MATRIXW.DEF is supplied so you can remember the options.
  345.       It's suggested that the user see this WELCOME file whenever he/she
  346.       joins the matrix conference/sub-board.
  347.  
  348.                              Multi-Network Systems
  349.                              ---------------------
  350.  
  351.         Often, systems will be in multiple networks, and your system may 
  352.     have several different addresses in multiple "zones."  If your system 
  353.     is set up this way, then you must have a different configuration file 
  354.     for each network. Suppose you belong to FidoNet in the USA which would 
  355.     make your ZONE number "1" and you also belong to RBBSNET which would 
  356.     make your ZONE number "8". That would also mean you most likely carry 
  357.     echo's from each network.  To keep your system from sending mail with a 
  358.     net/node number that doesn't make sense you should have a configuration 
  359.     file for each network, with a unique address for each.  F2RC and R2FC 
  360.     will then run multiple times, once for each network. 
  361.  
  362.                                   ErrorLevels 
  363.                                   -----------
  364.  
  365.     R2FC exits with an errorlevel of 2 if anything was exported, 1 if there 
  366.     was a disk error, or 0 otherwise. 
  367.  
  368.     F2RC exits with an errorlevel of 1 for a disk error, or 0 otherwise. 
  369.  
  370.                               Local Message Bases 
  371.                               -------------------
  372.  
  373.         You can use OverMail to renumber and pack your local (not to be 
  374.     exported to other systems) message bases, too, such as your main RBBS-
  375.     PC main message base.  Other messages bases, like sub-boards, can also 
  376.     be handled by OverMail.  You can put them in your config file so that 
  377.     they can be renumbered and packed on a regualr basis.  This will 
  378.     decrease the amout of hard disk space used by the message bases.  It 
  379.     also reduces the amount of work required to maintain your system.  To 
  380.     use OverMail on your local message bases, add them to OverMail.CFG. Put 
  381.     nothing in the "Fido Path" field and they'll just be packed and 
  382.     renumbered. 
  383.     
  384.  
  385.     
  386.                 Programs were written by 
  387.                                         Tom Collins
  388.                 Documentation butchered by
  389.                                         Michael Huggins
  390.                                         1:261/1041 FIDOnet
  391.                                         8:936/101  RBBS-net
  392.                                         1-301-343-1102 BBs
  393.                                         1-301-357-4629 Voice
  394.  
  395.